LeftProjection

data class LeftProjection<out L, out R>(either: Either<L, R>)

Functions

all

common

inline fun all(predicate: (L) -> Boolean): Boolean

Returns the result of applying the predicate to the value if this is Left or true if this is Right.

any

common

inline fun any(predicate: (L) -> Boolean): Boolean

Returns the result of applying the predicate to the value if this is Left or false if this is Right.

filter

common

inline fun filter(predicate: (L) -> Boolean): Either<L, R>?

Returns the same Left if the predicate is satisfied for the value.

filterIsInstance

common

inline fun <T> filterIsInstance(): Either<T, R>?

Returns the same Left casted to type T if it is T.

filterIsInstanceToOption

common

inline fun <T> filterIsInstanceToOption(): Option<Either<T, R>>

Returns Some containing the same Left casted to type T if it is T.

filterNot

common

inline fun filterNot(predicate: (L) -> Boolean): Either<L, R>?

Returns the same Left if the predicate is not satisfied for the value.

filterNotToOption

common

inline fun filterNotToOption(predicate: (L) -> Boolean): Option<Either<L, R>>

Returns Some containing the same Left if the predicate is not satisfied for the value.

filterToOption

common

inline fun filterToOption(predicate: (L) -> Boolean): Option<Either<L, R>>

Returns Some containing the same Left if the predicate is satisfied for the value.

forEach

common

inline fun forEach(action: (L) -> Unit)

Runs action if this is a Left.

get

common

fun get(): L

Gets value of this Left.

getOrNull

common

fun getOrNull(): L?

Gets value of this Left or null if this is Right.

map

common

inline fun <T> map(transform: (L) -> T): Either<T, R>

Maps value of this Left using transform.

none

common

inline fun none(predicate: (L) -> Boolean): Boolean

Returns false if the predicate is met by the value if this is Left or true otherwise.

toOption

common

fun toOption(): Option<L>

Returns a Some containing the Left value if it exists, or a None if this is a Right.

Properties

either

common

val either: Either<L, R>

Extensions

filterNotNull

common

fun <L, R> LeftProjection<L?, R>.filterNotNull(): Either<L, R>?

Returns the same Left if its value is not null.

filterNotNullToOption

common

fun <L, R> LeftProjection<L?, R>.filterNotNullToOption(): Option<Either<L, R>>

Returns Some containing the same Left if its value is not null.

filterOrElse

common

inline fun <L, R> LeftProjection<L, R>.filterOrElse(predicate: (L) -> Boolean, zero: () -> R): Either<L, R>?

Returns the same Left if the predicate is satisfied for the value, Right(zero) if the predicate is not satisfied for the value, or the same Right if this is Right.

flatMap

common

inline fun <L, R, T> LeftProjection<L, R>.flatMap(transform: (L) -> Either<T, R>): Either<T, R>

Maps value of this Left to a new Either using transform.

getOrElse

common

inline fun <L, R> LeftProjection<L, R>.getOrElse(default: () -> L): L

Gets value of this Left or default value if this is Right.